home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpbrushes.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  9.5 KB  |  211 lines
  1. <refentry id="libgimp-gimpbrushes" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpbrushes</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpbrushes</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-popup">gimp_brushes_popup</link>              (<link linkend="gchar">gchar</link> *brush_callback,
  18.                                              <link linkend="gchar">gchar</link> *popup_title,
  19.                                              <link linkend="gchar">gchar</link> *initial_brush,
  20.                                              <link linkend="gdouble">gdouble</link> opacity,
  21.                                              <link linkend="gint">gint</link> spacing,
  22.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
  23. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-close-popup">gimp_brushes_close_popup</link>        (<link linkend="gchar">gchar</link> *brush_callback);
  24. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-set-popup">gimp_brushes_set_popup</link>          (<link linkend="gchar">gchar</link> *brush_callback,
  25.                                              <link linkend="gchar">gchar</link> *brush_name,
  26.                                              <link linkend="gdouble">gdouble</link> opacity,
  27.                                              <link linkend="gint">gint</link> spacing,
  28.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
  29. <link linkend="gchar">gchar</link>*      <link linkend="gimp-brushes-get-brush-data">gimp_brushes_get_brush_data</link>     (<link linkend="gchar">gchar</link> *name,
  30.                                              <link linkend="gdouble">gdouble</link> *opacity,
  31.                                              <link linkend="gint">gint</link> *spacing,
  32.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> *paint_mode,
  33.                                              <link linkend="gint">gint</link> *width,
  34.                                              <link linkend="gint">gint</link> *height,
  35.                                              <link linkend="gint">gint</link> *length,
  36.                                              <link linkend="guint8">guint8</link> **mask_data);
  37. </synopsis>
  38. </refsynopsisdiv>
  39.  
  40.  
  41.  
  42.  
  43.  
  44. <refsect1>
  45. <title>Description</title>
  46. <para>
  47.  
  48. </para>
  49. </refsect1>
  50.  
  51. <refsect1>
  52. <title>Details</title>
  53. <refsect2>
  54. <title><anchor id="gimp-brushes-popup">gimp_brushes_popup ()</title>
  55. <programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_popup              (<link linkend="gchar">gchar</link> *brush_callback,
  56.                                              <link linkend="gchar">gchar</link> *popup_title,
  57.                                              <link linkend="gchar">gchar</link> *initial_brush,
  58.                                              <link linkend="gdouble">gdouble</link> opacity,
  59.                                              <link linkend="gint">gint</link> spacing,
  60.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
  61. <para>
  62. Invokes the Gimp brush selection.
  63. </para>
  64. <para>
  65. This procedure popups the brush selection dialog.</para>
  66. <para>
  67.  
  68. </para><informaltable pgwide=1 frame="none" role="params">
  69. <tgroup cols="2">
  70. <colspec colwidth="2*">
  71. <colspec colwidth="8*">
  72. <tbody>
  73. <row><entry align="right"><parameter>brush_callback</parameter> :</entry>
  74. <entry> The callback PDB proc to call when brush selection is made.
  75. </entry></row>
  76. <row><entry align="right"><parameter>popup_title</parameter> :</entry>
  77. <entry> Title to give the brush popup window.
  78. </entry></row>
  79. <row><entry align="right"><parameter>initial_brush</parameter> :</entry>
  80. <entry> The name of the brush to set as the first selected.
  81. </entry></row>
  82. <row><entry align="right"><parameter>opacity</parameter> :</entry>
  83. <entry> The initial opacity of the brush.
  84. </entry></row>
  85. <row><entry align="right"><parameter>spacing</parameter> :</entry>
  86. <entry> The initial spacing of the brush (if < 0 then use brush default spacing).
  87. </entry></row>
  88. <row><entry align="right"><parameter>paint_mode</parameter> :</entry>
  89. <entry> The initial paint mode.
  90. </entry></row>
  91. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  92. </entry></row>
  93. </tbody></tgroup></informaltable></refsect2>
  94. <refsect2>
  95. <title><anchor id="gimp-brushes-close-popup">gimp_brushes_close_popup ()</title>
  96. <programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_close_popup        (<link linkend="gchar">gchar</link> *brush_callback);</programlisting>
  97. <para>
  98. Popdown the Gimp brush selection.
  99. </para>
  100. <para>
  101. This procedure closes an opened brush selection dialog.</para>
  102. <para>
  103.  
  104. </para><informaltable pgwide=1 frame="none" role="params">
  105. <tgroup cols="2">
  106. <colspec colwidth="2*">
  107. <colspec colwidth="8*">
  108. <tbody>
  109. <row><entry align="right"><parameter>brush_callback</parameter> :</entry>
  110. <entry> The name of the callback registered for this popup.
  111. </entry></row>
  112. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  113. </entry></row>
  114. </tbody></tgroup></informaltable></refsect2>
  115. <refsect2>
  116. <title><anchor id="gimp-brushes-set-popup">gimp_brushes_set_popup ()</title>
  117. <programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_set_popup          (<link linkend="gchar">gchar</link> *brush_callback,
  118.                                              <link linkend="gchar">gchar</link> *brush_name,
  119.                                              <link linkend="gdouble">gdouble</link> opacity,
  120.                                              <link linkend="gint">gint</link> spacing,
  121.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
  122. <para>
  123. Sets the current brush selection in a popup.
  124. </para>
  125. <para>
  126. Sets the current brush selection in a popup.</para>
  127. <para>
  128.  
  129. </para><informaltable pgwide=1 frame="none" role="params">
  130. <tgroup cols="2">
  131. <colspec colwidth="2*">
  132. <colspec colwidth="8*">
  133. <tbody>
  134. <row><entry align="right"><parameter>brush_callback</parameter> :</entry>
  135. <entry> The name of the callback registered for this popup.
  136. </entry></row>
  137. <row><entry align="right"><parameter>brush_name</parameter> :</entry>
  138. <entry> The name of the brush to set as selected.
  139. </entry></row>
  140. <row><entry align="right"><parameter>opacity</parameter> :</entry>
  141. <entry> The initial opacity of the brush.
  142. </entry></row>
  143. <row><entry align="right"><parameter>spacing</parameter> :</entry>
  144. <entry> The initial spacing of the brush (if < 0 then use brush default spacing).
  145. </entry></row>
  146. <row><entry align="right"><parameter>paint_mode</parameter> :</entry>
  147. <entry> The initial paint mode.
  148. </entry></row>
  149. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  150. </entry></row>
  151. </tbody></tgroup></informaltable></refsect2>
  152. <refsect2>
  153. <title><anchor id="gimp-brushes-get-brush-data">gimp_brushes_get_brush_data ()</title>
  154. <programlisting><link linkend="gchar">gchar</link>*      gimp_brushes_get_brush_data     (<link linkend="gchar">gchar</link> *name,
  155.                                              <link linkend="gdouble">gdouble</link> *opacity,
  156.                                              <link linkend="gint">gint</link> *spacing,
  157.                                              <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> *paint_mode,
  158.                                              <link linkend="gint">gint</link> *width,
  159.                                              <link linkend="gint">gint</link> *height,
  160.                                              <link linkend="gint">gint</link> *length,
  161.                                              <link linkend="guint8">guint8</link> **mask_data);</programlisting>
  162. <para>
  163. Retrieve information about the currently active brush (including
  164. data).
  165. </para>
  166. <para>
  167. This procedure retrieves information about the currently active
  168. brush. This includes the brush name, and the brush extents (width
  169. and height). It also returns the brush data.</para>
  170. <para>
  171.  
  172. </para><informaltable pgwide=1 frame="none" role="params">
  173. <tgroup cols="2">
  174. <colspec colwidth="2*">
  175. <colspec colwidth="8*">
  176. <tbody>
  177. <row><entry align="right"><parameter>name</parameter> :</entry>
  178. <entry> the brush name (\"\" means current active pattern).
  179. </entry></row>
  180. <row><entry align="right"><parameter>opacity</parameter> :</entry>
  181. <entry> The brush opacity.
  182. </entry></row>
  183. <row><entry align="right"><parameter>spacing</parameter> :</entry>
  184. <entry> The brush spacing.
  185. </entry></row>
  186. <row><entry align="right"><parameter>paint_mode</parameter> :</entry>
  187. <entry> The paint mode.
  188. </entry></row>
  189. <row><entry align="right"><parameter>width</parameter> :</entry>
  190. <entry> The brush width.
  191. </entry></row>
  192. <row><entry align="right"><parameter>height</parameter> :</entry>
  193. <entry> The brush height.
  194. </entry></row>
  195. <row><entry align="right"><parameter>length</parameter> :</entry>
  196. <entry> Length of brush mask data.
  197. </entry></row>
  198. <row><entry align="right"><parameter>mask_data</parameter> :</entry>
  199. <entry> The brush mask data.
  200. </entry></row>
  201. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The brush name.
  202. </entry></row>
  203. </tbody></tgroup></informaltable></refsect2>
  204.  
  205. </refsect1>
  206.  
  207.  
  208.  
  209.  
  210. </refentry>
  211.